Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve descriptions of notation #3045

Merged
merged 18 commits into from
Dec 1, 2021

Conversation

henrikt-ma
Copy link
Collaborator

Fixes #3044.

This belongs in chapter 'Lexical Structure'.
Makes the introducing easier to digest, and places explanation where one would expect it.
These exceptions are just confusing as the grammar actually allows both 'der' and 'initial' (and also 'pure') to be used as the callee of a function call expression.
According to decreasing order of importance for readers.
In the introduction, it's better to just focus on notation.
Copy link
Member

@eshmoylova eshmoylova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requesting changes on the use of grammar in syntax.tex (which actually has been there before this PR but we are modifying that sentence anyway). Other comments are not required and are up for discussion.

chapters/introduction.tex Outdated Show resolved Hide resolved
chapters/introduction.tex Outdated Show resolved Hide resolved
chapters/syntax.tex Show resolved Hide resolved
@HansOlsson
Copy link
Collaborator

Looks good, except for the minor issues noted above.

Copy link
Member

@eshmoylova eshmoylova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the new look of the Notation section. I noticed one multi-line sentence but it was there before, so it's "if you want to fix now" and it is not required for this PR.

One other thing, which is not part of this PR but something that we discussed in #3034 is how Modelica comments are rendered in PDF. I noticed that when I view the pdf in a browser at 100% zoom some words appear much smaller, e.g. "represented" in the last comment.
image
If I zoom in they look the same size. Just thought I'd mention it in case we need more examples for #3034 (comment)

chapters/syntax.tex Show resolved Hide resolved
chapters/introduction.tex Show resolved Hide resolved
Copy link
Collaborator

@HansOlsson HansOlsson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good apart from some minor issues.

henrikt-ma and others added 3 commits November 30, 2021 22:23
Addressing commend by Hans.
As suggested by Hans.

Co-authored-by: Hans Olsson <HansOlsson@users.noreply.github.com>
Saying we 'do' invalid code sounded a bit too informal.
Copy link
Collaborator

@HansOlsson HansOlsson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@HansOlsson HansOlsson merged commit 7ca3c91 into modelica:master Dec 1, 2021
@henrikt-ma henrikt-ma deleted the notation-and-grammar-keywords branch December 1, 2021 21:25
@HansOlsson HansOlsson added the M36 For pull requests merged into Modelica 3.6 label Jul 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
M36 For pull requests merged into Modelica 3.6
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Boldface and non-boldface keywords
3 participants